<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.13" name="generator"/>
<title>OpenCV: cv::aruco::Board Class Reference</title>
<link href="../../opencv.ico" rel="shortcut icon" type="image/x-icon"/>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script src="../../jquery.js" type="text/javascript"></script>
<script src="../../dynsections.js" type="text/javascript"></script>
<script src="../../tutorial-utils.js" type="text/javascript"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script src="../../search/searchdata.js" type="text/javascript"></script>
<script src="../../search/search.js" type="text/javascript"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
  TeX: {
      Macros: {
          matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9],
          fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4],
          forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6],
          forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8],
          vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3],
          vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9],
          cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1],
          distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"],
          distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"],
          hdotsfor: ["\\dots", 1],
          mathbbm: ["\\mathbb{#1}", 1],
          bordermatrix: ["\\matrix{#1}", 1]
      }
  }
}
);
//]]>
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js" type="text/javascript"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css"/>
<link href="../../stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<!--#include virtual="/google-search.html"-->
<table cellpadding="0" cellspacing="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../opencv-logo-small.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">OpenCV
    <span id="projectnumber">4.5.2</span>
   </div>
   <div id="projectbrief">Open Source Computer Vision</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script src="../../menudata.js" type="text/javascript"></script>
<script src="../../menu.js" type="text/javascript"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
  <ul>
<li class="navelem"><a class="el" href="../../d2/d75/namespacecv.html">cv</a></li><li class="navelem"><a class="el" href="../../d4/d17/namespacecv_1_1aruco.html">aruco</a></li><li class="navelem"><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html">Board</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="../../d6/dc7/classcv_1_1aruco_1_1Board-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cv::aruco::Board Class Reference<div class="ingroups"><a class="el" href="../../d9/d6a/group__aruco.html">ArUco Marker Detection</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html" title="Board of markers. ">Board</a> of markers.  
 <a href="../../d4/db2/classcv_1_1aruco_1_1Board.html#details">More...</a></p>
<p><code>#include &lt;opencv2/aruco.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cv::aruco::Board:</div>
<div class="dyncontent">
 <div class="center">
  <img alt="" src="../../d4/db2/classcv_1_1aruco_1_1Board.png" usemap="#cv::aruco::Board_map"/>
  <map id="cv::aruco::Board_map" name="cv::aruco::Board_map">
<area alt="cv::aruco::CharucoBoard" coords="0,56,154,80" href="../../d0/d3c/classcv_1_1aruco_1_1CharucoBoard.html" shape="rect" title="ChArUco board Specific class for ChArUco boards. A ChArUco board is a planar board where the markers ..."/>
<area alt="cv::aruco::GridBoard" coords="164,56,318,80" href="../../de/d05/classcv_1_1aruco_1_1GridBoard.html" shape="rect" title="Planar board with grid arrangement of markers More common type of board. All markers are placed in th..."/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a06243c9dcd6fedf32992388aa7527f59"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html">Board</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#a06243c9dcd6fedf32992388aa7527f59">create</a> (<a class="el" href="../../dc/d84/group__core__basic.html#ga606feabe3b50ab6838f1ba89727aa07a">InputArrayOfArrays</a> <a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#ae7c2f21aa18add0211c360935e3f589b">objPoints</a>, const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; &amp;<a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#a733dd520d8e00312200aadab83c66672">dictionary</a>, <a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> <a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#a101fa2154784ce5560898763773d6bd4">ids</a>)</td></tr>
<tr class="memdesc:a06243c9dcd6fedf32992388aa7527f59"><td class="mdescLeft"> </td><td class="mdescRight">Provide way to create <a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html" title="Board of markers. ">Board</a> by passing necessary data. Specially needed in Python.  <a href="#a06243c9dcd6fedf32992388aa7527f59">More...</a><br/></td></tr>
<tr class="separator:a06243c9dcd6fedf32992388aa7527f59"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a733dd520d8e00312200aadab83c66672"><td align="right" class="memItemLeft" valign="top"><a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#a733dd520d8e00312200aadab83c66672">dictionary</a></td></tr>
<tr class="memdesc:a733dd520d8e00312200aadab83c66672"><td class="mdescLeft"> </td><td class="mdescRight">the dictionary of markers employed for this board  <a href="#a733dd520d8e00312200aadab83c66672">More...</a><br/></td></tr>
<tr class="separator:a733dd520d8e00312200aadab83c66672"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a101fa2154784ce5560898763773d6bd4"><td align="right" class="memItemLeft" valign="top">std::vector&lt; int &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#a101fa2154784ce5560898763773d6bd4">ids</a></td></tr>
<tr class="separator:a101fa2154784ce5560898763773d6bd4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae7c2f21aa18add0211c360935e3f589b"><td align="right" class="memItemLeft" valign="top">std::vector&lt; std::vector&lt; <a class="el" href="../../dc/d84/group__core__basic.html#ga3d79ceeb4419bccd0308dfdf1cd31435">Point3f</a> &gt; &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html#ae7c2f21aa18add0211c360935e3f589b">objPoints</a></td></tr>
<tr class="separator:ae7c2f21aa18add0211c360935e3f589b"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html" title="Board of markers. ">Board</a> of markers. </p>
<p>A board is a set of markers in the 3D space with a common coordinate system. The common form of a board of marker is a planar (2D) board, however any 3D layout can be used. A <a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html" title="Board of markers. ">Board</a> object is composed by:</p><ul>
<li>The object points of the marker corners, i.e. their coordinates respect to the board system.</li>
<li>The dictionary which indicates the type of markers of the board</li>
<li>The identifier of all the markers in the board. </li>
</ul>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a06243c9dcd6fedf32992388aa7527f59"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a06243c9dcd6fedf32992388aa7527f59">◆ </a></span>create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html">Board</a>&gt; cv::aruco::Board::create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga606feabe3b50ab6838f1ba89727aa07a">InputArrayOfArrays</a> </td>
          <td class="paramname"><em>objPoints</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a> &gt; &amp; </td>
          <td class="paramname"><em>dictionary</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> </td>
          <td class="paramname"><em>ids</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.aruco.Board_create(</td><td class="paramname">objPoints, dictionary, ids</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Provide way to create <a class="el" href="../../d4/db2/classcv_1_1aruco_1_1Board.html" title="Board of markers. ">Board</a> by passing necessary data. Specially needed in Python. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">objPoints</td><td>array of object points of all the marker corners in the board </td></tr>
    <tr><td class="paramname">dictionary</td><td>the dictionary of markers employed for this board </td></tr>
    <tr><td class="paramname">ids</td><td>vector of the identifiers of the markers in the board </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a733dd520d8e00312200aadab83c66672"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a733dd520d8e00312200aadab83c66672">◆ </a></span>dictionary</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d5/d0b/classcv_1_1aruco_1_1Dictionary.html">Dictionary</a>&gt; cv::aruco::Board::dictionary</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>the dictionary of markers employed for this board </p>
</div>
</div>
<a id="a101fa2154784ce5560898763773d6bd4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a101fa2154784ce5560898763773d6bd4">◆ </a></span>ids</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt; int &gt; cv::aruco::Board::ids</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>vector of the identifiers of the markers in the board (same size than objPoints) The identifiers refers to the board dictionary </p>
</div>
</div>
<a id="ae7c2f21aa18add0211c360935e3f589b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7c2f21aa18add0211c360935e3f589b">◆ </a></span>objPoints</h2>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">std::vector&lt; std::vector&lt; <a class="el" href="../../dc/d84/group__core__basic.html#ga3d79ceeb4419bccd0308dfdf1cd31435">Point3f</a> &gt; &gt; cv::aruco::Board::objPoints</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>array of object points of all the marker corners in the board each marker include its 4 corners in CCW order. For M markers, the size is Mx4. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>opencv2/<a class="el" href="../../d9/d53/aruco_8hpp.html">aruco.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 2 2021 11:36:43 for OpenCV by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="../../doxygen.png"/>
</a> 1.8.13
</small></address>
<script type="text/javascript">
//<![CDATA[
addTutorialsButtons();
//]]>
</script>
</body>
</html>
